<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EOS.IO: Single String Index table</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="eos-logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">EOS.IO
   &#160;<span id="projectnumber">DAWN3.0.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Single String Index table<div class="ingroups"><a class="el" href="group__contractdev.html">Smart Contract API Reference</a> &raquo; <a class="el" href="group__database.html">Database API</a> &raquo; <a class="el" href="group__database_c.html">Database C API</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>These methods interface with a simple table with String unique primary key and arbitrary binary data value.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga1094b9ec775a7ee73e1ef1d14710dc5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dbstr.html#ga1094b9ec775a7ee73e1ef1d14710dc5c">store_str</a> (<a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> scope, <a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a> table, char *key, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> keylen, char *value, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> valuelen)</td></tr>
<tr class="separator:ga1094b9ec775a7ee73e1ef1d14710dc5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaae68a34eecfef147c41c36d34a7f7887"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dbstr.html#gaae68a34eecfef147c41c36d34a7f7887">update_str</a> (<a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> scope, <a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a> table, char *key, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> keylen, char *value, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> valuelen)</td></tr>
<tr class="separator:gaae68a34eecfef147c41c36d34a7f7887"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac87dd131f6ae378be362144f7b068284"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dbstr.html#gac87dd131f6ae378be362144f7b068284">load_str</a> (<a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> scope, <a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> code, <a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a> table, char *key, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> keylen, char *value, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> valuelen)</td></tr>
<tr class="separator:gac87dd131f6ae378be362144f7b068284"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa22211a254d878ab4aa78bcd93f1ca85"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dbstr.html#gaa22211a254d878ab4aa78bcd93f1ca85">front_str</a> (<a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> scope, <a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> code, <a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a> table, char *value, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> valuelen)</td></tr>
<tr class="separator:gaa22211a254d878ab4aa78bcd93f1ca85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9c8473a7fd1e3d179d5f202ad744b1c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dbstr.html#ga9c8473a7fd1e3d179d5f202ad744b1c7">back_str</a> (<a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> scope, <a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> code, <a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a> table, char *value, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> valuelen)</td></tr>
<tr class="separator:ga9c8473a7fd1e3d179d5f202ad744b1c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga29fb2e3e8b45b5fe07ef3c4049b1ee79"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dbstr.html#ga29fb2e3e8b45b5fe07ef3c4049b1ee79">next_str</a> (<a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> scope, <a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> code, <a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a> table, char *key, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> keylen, char *value, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> valuelen)</td></tr>
<tr class="separator:ga29fb2e3e8b45b5fe07ef3c4049b1ee79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8b891f35f20aee1941bb2f9eef5f43ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dbstr.html#ga8b891f35f20aee1941bb2f9eef5f43ef">previous_str</a> (<a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> scope, <a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> code, <a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a> table, char *key, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> keylen, char *value, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> valuelen)</td></tr>
<tr class="separator:ga8b891f35f20aee1941bb2f9eef5f43ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga671bed299aa2b85916f4819bfa2f7465"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dbstr.html#ga671bed299aa2b85916f4819bfa2f7465">lower_bound_str</a> (<a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> scope, <a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> code, <a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a> table, char *key, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> keylen, char *value, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> valuelen)</td></tr>
<tr class="separator:ga671bed299aa2b85916f4819bfa2f7465"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga355396e5c382b2056bb8b159928b4517"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dbstr.html#ga355396e5c382b2056bb8b159928b4517">upper_bound_str</a> (<a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> scope, <a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> code, <a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a> table, char *key, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> keylen, char *value, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> valuelen)</td></tr>
<tr class="separator:ga355396e5c382b2056bb8b159928b4517"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa468d0143c8e74dfad42915214cd2218"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dbstr.html#gaa468d0143c8e74dfad42915214cd2218">remove_str</a> (<a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> scope, <a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a> table, char *key, <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> keylen)</td></tr>
<tr class="separator:gaa468d0143c8e74dfad42915214cd2218"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<dl class="section see"><dt>See also</dt><dd>table class in C++ API </dd></dl>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga9c8473a7fd1e3d179d5f202ad744b1c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9c8473a7fd1e3d179d5f202ad744b1c7">&#9670;&nbsp;</a></span>back_str()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a> back_str </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>scope</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>code</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a>&#160;</td>
          <td class="paramname"><em>table</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>valuelen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">scope</td><td>- the account scope that will be read, must exist in the transaction scopes list </td></tr>
    <tr><td class="paramname">code</td><td>- identifies the code that controls write-access to the data </td></tr>
    <tr><td class="paramname">table</td><td>- the ID/name of the table within the scope/code context to query </td></tr>
    <tr><td class="paramname">key</td><td>- location of the record key </td></tr>
    <tr><td class="paramname">keylen</td><td>- length of the record key </td></tr>
    <tr><td class="paramname">value</td><td>- location to copy the back record value </td></tr>
    <tr><td class="paramname">valuelen</td><td>- maximum length of the record value to read </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes read or -1 if key was not found </dd></dl>

</div>
</div>
<a id="gaa22211a254d878ab4aa78bcd93f1ca85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa22211a254d878ab4aa78bcd93f1ca85">&#9670;&nbsp;</a></span>front_str()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a> front_str </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>scope</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>code</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a>&#160;</td>
          <td class="paramname"><em>table</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>valuelen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">scope</td><td>- the account scope that will be read, must exist in the transaction scopes list </td></tr>
    <tr><td class="paramname">code</td><td>- identifies the code that controls write-access to the data </td></tr>
    <tr><td class="paramname">table</td><td>- the ID/name of the table within the scope/code context to query </td></tr>
    <tr><td class="paramname">key</td><td>- location of the record key </td></tr>
    <tr><td class="paramname">keylen</td><td>- length of the record key </td></tr>
    <tr><td class="paramname">value</td><td>- location to copy the front record value </td></tr>
    <tr><td class="paramname">valuelen</td><td>- maximum length of the record value to read </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes read or -1 if key was not found </dd></dl>

</div>
</div>
<a id="gac87dd131f6ae378be362144f7b068284"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac87dd131f6ae378be362144f7b068284">&#9670;&nbsp;</a></span>load_str()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a> load_str </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>scope</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>code</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a>&#160;</td>
          <td class="paramname"><em>table</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>keylen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>valuelen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">scope</td><td>- the account scope that will be read, must exist in the transaction scopes list </td></tr>
    <tr><td class="paramname">code</td><td>- identifies the code that controls write-access to the data </td></tr>
    <tr><td class="paramname">table</td><td>- the ID/name of the table within the scope/code context to query </td></tr>
    <tr><td class="paramname">key</td><td>- location of the record key </td></tr>
    <tr><td class="paramname">keylen</td><td>- length of the record key </td></tr>
    <tr><td class="paramname">value</td><td>- location to copy the record value </td></tr>
    <tr><td class="paramname">valuelen</td><td>- maximum length of the record value to read</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes read or -1 if key was not found </dd></dl>

</div>
</div>
<a id="ga671bed299aa2b85916f4819bfa2f7465"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga671bed299aa2b85916f4819bfa2f7465">&#9670;&nbsp;</a></span>lower_bound_str()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a> lower_bound_str </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>scope</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>code</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a>&#160;</td>
          <td class="paramname"><em>table</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>keylen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>valuelen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">scope</td><td>- the account scope that will be read, must exist in the transaction scopes list </td></tr>
    <tr><td class="paramname">code</td><td>- identifies the code that controls write-access to the data </td></tr>
    <tr><td class="paramname">table</td><td>- the ID/name of the table within the scope/code context to query </td></tr>
    <tr><td class="paramname">key</td><td>- location of the record key </td></tr>
    <tr><td class="paramname">keylen</td><td>- length of the record key </td></tr>
    <tr><td class="paramname">value</td><td>- location to copy the lower bound record value </td></tr>
    <tr><td class="paramname">valuelen</td><td>- maximum length of the record value to read </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes read or -1 if key was not found </dd></dl>

</div>
</div>
<a id="ga29fb2e3e8b45b5fe07ef3c4049b1ee79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga29fb2e3e8b45b5fe07ef3c4049b1ee79">&#9670;&nbsp;</a></span>next_str()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a> next_str </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>scope</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>code</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a>&#160;</td>
          <td class="paramname"><em>table</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>keylen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>valuelen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">scope</td><td>- the account scope that will be read, must exist in the transaction scopes list </td></tr>
    <tr><td class="paramname">code</td><td>- identifies the code that controls write-access to the data </td></tr>
    <tr><td class="paramname">table</td><td>- the ID/name of the table within the scope/code context to query </td></tr>
    <tr><td class="paramname">key</td><td>- location of the record key </td></tr>
    <tr><td class="paramname">keylen</td><td>- length of the record key </td></tr>
    <tr><td class="paramname">value</td><td>- location to copy the next record value </td></tr>
    <tr><td class="paramname">valuelen</td><td>- maximum length of the record value to read </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes read or -1 if key was not found </dd></dl>

</div>
</div>
<a id="ga8b891f35f20aee1941bb2f9eef5f43ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8b891f35f20aee1941bb2f9eef5f43ef">&#9670;&nbsp;</a></span>previous_str()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a> previous_str </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>scope</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>code</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a>&#160;</td>
          <td class="paramname"><em>table</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>keylen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>valuelen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">scope</td><td>- the account scope that will be read, must exist in the transaction scopes list </td></tr>
    <tr><td class="paramname">code</td><td>- identifies the code that controls write-access to the data </td></tr>
    <tr><td class="paramname">table</td><td>- the ID/name of the table within the scope/code context to query </td></tr>
    <tr><td class="paramname">key</td><td>- location of the record key </td></tr>
    <tr><td class="paramname">keylen</td><td>- length of the record key </td></tr>
    <tr><td class="paramname">value</td><td>- location to copy the previous record value </td></tr>
    <tr><td class="paramname">valuelen</td><td>- maximum length of the record value to read </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes read or -1 if key was not found </dd></dl>

</div>
</div>
<a id="gaa468d0143c8e74dfad42915214cd2218"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa468d0143c8e74dfad42915214cd2218">&#9670;&nbsp;</a></span>remove_str()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a> remove_str </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>scope</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a>&#160;</td>
          <td class="paramname"><em>table</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>keylen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">key</td><td>- location of the record key </td></tr>
    <tr><td class="paramname">keylen</td><td>- length of the record key</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if a record was removed, and 0 if no record with key was found </dd></dl>

</div>
</div>
<a id="ga1094b9ec775a7ee73e1ef1d14710dc5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1094b9ec775a7ee73e1ef1d14710dc5c">&#9670;&nbsp;</a></span>store_str()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a> store_str </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>scope</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a>&#160;</td>
          <td class="paramname"><em>table</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>keylen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>valuelen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">scope</td><td>- the account scope that will be read, must exist in the transaction scopes list </td></tr>
    <tr><td class="paramname">table</td><td>- the ID/name of the table within the current scope/code context to modify</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if a new record was created, 0 if an existing record was updated</dd></dl>
<dl class="section pre"><dt>Precondition</dt><dd>keylen &gt;= 0 </dd>
<dd>
key is a valid pointer to a range of memory at least keylen bytes long </dd>
<dd>
the memory range [key...key+len) stores the primary key </dd>
<dd>
valuelen &gt;= 0 </dd>
<dd>
value is a valid pointer to a range of memory at least valuelen bytes long </dd>
<dd>
the memory range [value...value+valuelen) stores the arbitrary binary data value </dd>
<dd>
scope is declared by the current transaction </dd>
<dd>
this method is being called from an apply context (not validate or precondition)</dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>a record is either created or updated with the given scope and table.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">if</td><td>called with an invalid precondition execution will be aborted </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaae68a34eecfef147c41c36d34a7f7887"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaae68a34eecfef147c41c36d34a7f7887">&#9670;&nbsp;</a></span>update_str()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a> update_str </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>scope</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a>&#160;</td>
          <td class="paramname"><em>table</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>keylen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>valuelen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">scope</td><td>- the account scope that will be read, must exist in the transaction scopes list </td></tr>
    <tr><td class="paramname">table</td><td>- the ID/name of the table within the current scope/code context to modify</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the record was updated, 0 if no record with key was found</dd></dl>
<dl class="section pre"><dt>Precondition</dt><dd>keylen &gt;= 0 </dd>
<dd>
key is a valid pointer to a range of memory at least keylen bytes long </dd>
<dd>
the memory range [key...key+len) stores the primary key </dd>
<dd>
valuelen &gt;= 0 </dd>
<dd>
value is a valid pointer to a range of memory at least valuelen bytes long </dd>
<dd>
the memory range [value...value+valuelen) stores the arbitrary binary data value </dd>
<dd>
scope is declared by the current transaction </dd>
<dd>
this method is being called from an apply context (not validate or precondition)</dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>a record is either created or updated with the given scope and table.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">if</td><td>called with an invalid precondition execution will be aborted </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga355396e5c382b2056bb8b159928b4517"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga355396e5c382b2056bb8b159928b4517">&#9670;&nbsp;</a></span>upper_bound_str()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__types.html#ga0d2e949ab6a1bb62f1b295cc79bc1f60">int32_t</a> upper_bound_str </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>scope</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a>&#160;</td>
          <td class="paramname"><em>code</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga330cbf48637c876c57f78d03fd4730bb">table_name</a>&#160;</td>
          <td class="paramname"><em>table</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>keylen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td>
          <td class="paramname"><em>valuelen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">scope</td><td>- the account scope that will be read, must exist in the transaction scopes list </td></tr>
    <tr><td class="paramname">code</td><td>- identifies the code that controls write-access to the data </td></tr>
    <tr><td class="paramname">table</td><td>- the ID/name of the table within the scope/code context to query </td></tr>
    <tr><td class="paramname">key</td><td>- location of the record key </td></tr>
    <tr><td class="paramname">keylen</td><td>- length of the record key </td></tr>
    <tr><td class="paramname">value</td><td>- location to copy the upper bound record value </td></tr>
    <tr><td class="paramname">valuelen</td><td>- maximum length of the record value to read </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes read or -1 if key was not found </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
